home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / comm / pccp019.zip / MANUAL < prev    next >
Text File  |  1992-05-08  |  5KB  |  127 lines
  1.  
  2.  
  3.           Pete Cann's Communication Package
  4.  
  5.         Portions Copyright (C) 1992 Peter Edward Cann
  6.  
  7.          (Please see the file README for legal junk)
  8.  
  9. This is a set of programs and data files for communication between a
  10. PC and something external, possibly over a modem. It is drastically
  11. different from most other communications programs, in that it is
  12. highly modular and generally requires the user to write batch files
  13. and/or scripts to make use of it. This is what you might call a
  14. "hacker style" paradigm (not to be confused with "cracker", generally
  15. an infantile individual who feels so insignificant that they screw
  16. other people in a desperate attempt to feel powerful). Hackers are
  17. people who are very comfortable with computers, and like to have a
  18. lot of control and to know what's going on. The source code for all
  19. of these programs is included in the distribution, so if you know C
  20. you have all the information I do now.
  21.  
  22. All of the programs give USAGE: information if invoked without
  23. arguments.
  24.  
  25. The centerpiece of the package is TERM. This is a terminal emulator.
  26. It takes an emulation file, which you create or modify with EMUED.
  27. EMUED lets you specify strings to send for any programmable key, and
  28. lets you enter strings of characters and substitution tokens to
  29. invoke functions. These would be the "escape sequences", although
  30. they need not begin with Escape. The token codes are in EMU.H. The
  31. emulation facility also provides a graphics character substitution
  32. table for graphics character commands. TERM and EMUED look in the
  33. directory named by the TERM environment variable for emulation files,
  34. if TERM is set. The program CCODES types a hex listing of display
  35. character codes for use when assigning graphics characters in EMUED.
  36.  
  37. The program MASTERM invokes term with the three or four arguments,
  38. but if you exit term you get a menu for file transfers or beginning a
  39. dribble file. The file transfer programs are three variations on
  40. XMODEM in each direction, and have fairly clear names.
  41.  
  42. The program HOST is a simple one-password host. It is hard-coded for
  43. 8n1 bits. It expects the modem to be in AT&C1&D2 mode, that is,
  44. Carrier Detect conveys information and Data Terminal Ready controls
  45. hookswitch. The shell has no extra protection, because calling the
  46. FTP protocols creates a potential trap-door situation anyway. The
  47. host program presently only operates at the specified speed, because
  48. I don't off-hand know a neat way to autobaud. Lots of modems these
  49. days speed-buffer anyway. The environment of any subschell contains
  50. REMOTE=YES, so you can do IF NOT "%REMOTE%"=="YES" THING in a batch
  51. file, where THING is something that would be bad to do from a
  52. comport, such as run a display editor.
  53.  
  54. The program COMSCRPT runs scripts. It is very powerful, with multiple
  55. branching look-fors, timeouts and retry limits.
  56.  
  57. The script file must have the extension ".SCR". If the TERM
  58. environment variable is set, the program looks for the script there.
  59. The program loads the script into RAM and then executes it. Lines are
  60. limited to 80 characters. The number of lines is limited to 255.
  61.  
  62. The characters '|' and '~' are special. '|' means CR in < lines and >
  63. lines (LF is stripped for > processing); and newline in ! lines. '~'
  64. means 0.4 second delay in < lines and bell in ! lines. (In > lines it
  65. means itself.)
  66.  
  67. The first line of the script file is the first three arguments as for
  68. TERM, space-delimited. In subsequent lines, the first character of
  69. each line is the command; the rest of the line (after the delimiting
  70. space) is argument(s). A final string argument may include spaces,
  71. and begins after the delimiting space. Blank lines are ignored.
  72.  
  73. The command characters are as follows:
  74.  
  75. ;
  76.     {introduces comment; line ignored; space not required}
  77.  
  78. : <decimal number 0-255>
  79.     {label for conditional or unconditional goto} 
  80.  
  81. g <label #>
  82.     {goto label #}
  83.  
  84. r <label #> <retries>
  85.     {resets retry count and goes to label if hit more than retries}
  86.  
  87. p <seconds>
  88.     {processes pending look-fors; falls through upon timeout}
  89.     {clears pending look-for list upon completion}
  90.  
  91. > <label #> <string>
  92.     {look for string upon p command; if hit goto label}
  93.     {incoming linefeeds ignored}
  94.  
  95. ? <label #>
  96.     {goto label if Clear To Send or Tx Hold Reg Empty is false}
  97.  
  98. < <string>
  99.     {send string to port}
  100.  
  101. ! <string>
  102.     {send string to console}
  103.  
  104. s <label #> <command line string>
  105.     {run system command line and wait for termination}
  106.     {goto label # if error in running command.com}
  107.     {will not report errors within command string}
  108.  
  109. q <exit code>
  110.     {quit with exit code}
  111.     {codes other than zero under 128 are reserved to internals}
  112.  
  113. When scripting modem commands, which is how you're intended to
  114. configure and dial the modem, try a ~ before and after the at, for
  115. instance:
  116.  
  117.     < ~at~&f&c1&d2|
  118.  
  119. The program SCRCHK types a listing of the argument script file giving
  120. statement numbers, which are not the same as line numbers. It leaves
  121. out blank lines for some reason. It also detects some errors.
  122.  
  123. All of the I/O programs except TERM pay attention to CTS. None of
  124. them do XON/XOFF. The computer is assumed to be fast enough to keep
  125. up. However, since DOS video is very slow, TERM will suspend display
  126. if a buffer overrun threatens.
  127.